refactor(storage): standardize ERC-7201 annotations and pin literals …#17
Merged
Merged
Conversation
…to namespaces The nine namespaced storage modules documented their ERC-7201 location four different ways: the canonical @Custom:storage-location on the struct, an informal @dev erc7201: note on the constant, both at once, or neither. FeeStorage and the three strategy structs had no canonical annotation at all, so tooling that keys on @Custom:storage-location would not recognize them as namespaced. Standardize on the canonical form: @Custom:storage-location erc7201:<id> on the struct only, plus a uniform derivation comment above each precomputed slot constant. Slot values, constant names, struct names, and accessor names are unchanged, so there is no bytecode or call-site impact. LibDiamond keeps its canonical EIP-2535 keccak namespace and is intentionally left as is. Add test/unit/StorageNamespaces.t.sol, which recomputes erc7201(namespace) for every module and asserts it equals the pasted literal, so a slot can never silently drift from its namespace string.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…to namespaces
The nine namespaced storage modules documented their ERC-7201 location four different ways: the canonical @Custom:storage-location on the struct, an informal @dev erc7201: note on the constant, both at once, or neither. FeeStorage and the three strategy structs had no canonical annotation at all, so tooling that keys on @Custom:storage-location would not recognize them as namespaced.
Standardize on the canonical form: @Custom:storage-location erc7201: on the struct only, plus a uniform derivation comment above each precomputed slot constant. Slot values, constant names, struct names, and accessor names are unchanged, so there is no bytecode or call-site impact. LibDiamond keeps its canonical EIP-2535 keccak namespace and is intentionally left as is.
Add test/unit/StorageNamespaces.t.sol, which recomputes erc7201(namespace) for every module and asserts it equals the pasted literal, so a slot can never silently drift from its namespace string.